<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html>
<head>
<link rel="STYLESHEET" href="lib.css" type='text/css' />
<link rel="SHORTCUT ICON" href="../icons/pyfav.png" type="image/png" />
<link rel='start' href='../index.html' title='Python documentation Index' />
<link rel="first" href="lib.html" title='Python library Reference' />
<link rel='contents' href='contents.html' title="Contents" />
<link rel='index' href='genindex.html' title='Index' />
<link rel='last' href='about.html' title='About this document...' />
<link rel='help' href='about.html' title='About this document...' />
<link rel="next" href="module-zipfile.html" />
<link rel="prev" href="module-gzip.html" />
<link rel="parent" href="archiving.html" />
<link rel="next" href="node301.html" />
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name='aesop' content='information' />
<title>12.3 bz2 -- Compression compatible with bzip2</title>
</head>
<body>
<div class="navigation">
<div id='top-navigation-panel' xml:id='top-navigation-panel'>
<table align="center" width="100%" cellpadding="0" cellspacing="2">
<tr>
<td class='online-navigation'><a rel="prev" title="12.2 gzip  "
  href="module-gzip.html"><img src='../icons/previous.png'
  border='0' height='32'  alt='Previous Page' width='32' /></a></td>
<td class='online-navigation'><a rel="parent" title="12. data Compression and"
  href="archiving.html"><img src='../icons/up.png'
  border='0' height='32'  alt='Up one Level' width='32' /></a></td>
<td class='online-navigation'><a rel="next" title="12.3.1 (De)compression of files"
  href="node301.html"><img src='../icons/next.png'
  border='0' height='32'  alt='Next Page' width='32' /></a></td>
<td align="center" width="100%">Python Library Reference</td>
<td class='online-navigation'><a rel="contents" title="Table of Contents"
  href="contents.html"><img src='../icons/contents.png'
  border='0' height='32'  alt='Contents' width='32' /></a></td>
<td class='online-navigation'><a href="modindex.html" title="Module Index"><img src='../icons/modules.png'
  border='0' height='32'  alt='Module Index' width='32' /></a></td>
<td class='online-navigation'><a rel="index" title="Index"
  href="genindex.html"><img src='../icons/index.png'
  border='0' height='32'  alt='Index' width='32' /></a></td>
</tr></table>
<div class='online-navigation'>
<b class="navlabel">Previous:</b>
<a class="sectref" rel="prev" href="module-gzip.html">12.2 gzip  </a>
<b class="navlabel">Up:</b>
<a class="sectref" rel="parent" href="archiving.html">12. Data Compression and</a>
<b class="navlabel">Next:</b>
<a class="sectref" rel="next" href="node301.html">12.3.1 (De)compression of files</a>
</div>
<hr /></div>
</div>
<!--End of Navigation Panel-->

<h1><a name="SECTION0014300000000000000000">
12.3 <tt class="module">bz2</tt> --
         Compression compatible with <b class="program">bzip2</b></a>
</h1>

<p>
<a name="module-bz2"></a>

<p>

<span class="versionnote">New in version 2.3.</span>

<p>
This module provides a comprehensive interface for the bz2 compression library.
It implements a complete file interface, one-shot (de)compression functions,
and types for sequential (de)compression.

<p>
Here is a resume of the features offered by the bz2 module:

<p>

<ul>
<li><tt class="class">BZ2File</tt> class implements a complete file interface, including
      <tt class="method">readline()</tt>, <tt class="method">readlines()</tt>,
      <tt class="method">writelines()</tt>, <tt class="method">seek()</tt>, etc;
</li>
<li><tt class="class">BZ2File</tt> class implements emulated <tt class="method">seek()</tt> support;
</li>
<li><tt class="class">BZ2File</tt> class implements universal newline support;
</li>
<li><tt class="class">BZ2File</tt> class offers an optimized line iteration using
      the readahead algorithm borrowed from file objects;
</li>
<li>Sequential (de)compression supported by <tt class="class">BZ2Compressor</tt> and
      <tt class="class">BZ2Decompressor</tt> classes;
</li>
<li>One-shot (de)compression supported by <tt class="function">compress()</tt> and
      <tt class="function">decompress()</tt> functions;
</li>
<li>Thread safety uses individual locking mechanism;
</li>
<li>Complete inline documentation;
</li>
</ul>

<p>

<p><br /></p><hr class='online-navigation' />
<div class='online-navigation'>
<!--Table of Child-Links-->
<a name="CHILD_LINKS"><strong>Subsections</strong></a>

<ul class="ChildLinks">
<li><a href="node301.html">12.3.1 (De)compression of files</a>
<li><a href="node302.html">12.3.2 Sequential (de)compression</a>
<li><a href="node303.html">12.3.3 One-shot (de)compression</a>
</ul>
<!--End of Table of Child-Links-->
</div>

<div class="navigation">
<div class='online-navigation'>
<p></p><hr />
<table align="center" width="100%" cellpadding="0" cellspacing="2">
<tr>
<td class='online-navigation'><a rel="prev" title="12.2 gzip  "
  href="module-gzip.html"><img src='../icons/previous.png'
  border='0' height='32'  alt='Previous Page' width='32' /></a></td>
<td class='online-navigation'><a rel="parent" title="12. data Compression and"
  href="archiving.html"><img src='../icons/up.png'
  border='0' height='32'  alt='Up one Level' width='32' /></a></td>
<td class='online-navigation'><a rel="next" title="12.3.1 (De)compression of files"
  href="node301.html"><img src='../icons/next.png'
  border='0' height='32'  alt='Next Page' width='32' /></a></td>
<td align="center" width="100%">Python Library Reference</td>
<td class='online-navigation'><a rel="contents" title="Table of Contents"
  href="contents.html"><img src='../icons/contents.png'
  border='0' height='32'  alt='Contents' width='32' /></a></td>
<td class='online-navigation'><a href="modindex.html" title="Module Index"><img src='../icons/modules.png'
  border='0' height='32'  alt='Module Index' width='32' /></a></td>
<td class='online-navigation'><a rel="index" title="Index"
  href="genindex.html"><img src='../icons/index.png'
  border='0' height='32'  alt='Index' width='32' /></a></td>
</tr></table>
<div class='online-navigation'>
<b class="navlabel">Previous:</b>
<a class="sectref" rel="prev" href="module-gzip.html">12.2 gzip  </a>
<b class="navlabel">Up:</b>
<a class="sectref" rel="parent" href="archiving.html">12. Data Compression and</a>
<b class="navlabel">Next:</b>
<a class="sectref" rel="next" href="node301.html">12.3.1 (De)compression of files</a>
</div>
</div>
<hr />
<span class="release-info">Release 2.5.1, documentation updated on 18th April, 2007.</span>
</div>
<!--End of Navigation Panel-->
<address>
See <i><a href="about.html">About this document...</a></i> for information on suggesting changes.
</address>
</body>
</html>
